* isearch.el (isearch-search-fun-function): Clarify further the

meaning of the function returned.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 0c4a09900942c78014c74fb7557f40bdd50ddd7b..1c50a01b9eb9b10a15bc1c1faee54b4cce86fb9d 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2011-07-04  Lars Magne Ingebrigtsen  <larsi@gnus.org>
+
+       * isearch.el (isearch-search-fun-function): Clarify further the
+       meaning of the function returned.
+
 2011-07-04  Michael Albinus  <michael.albinus@gmx.de>
 
        * net/tramp-cmds.el (tramp-cleanup-this-connection): New command.

diff --git a/lisp/isearch.el b/lisp/isearch.el
index 58af9236d51185c551fad014dc208fb0b5ed1b3e..50e7b331c85910f0387feb70827c2f9b193b57d4 100644 (file)
--- a/lisp/isearch.el
+++ b/lisp/isearch.el
@@ -2227,9 +2227,12 @@ If there is no completion possible, say so and continue searching."
 
 (defvar isearch-search-fun-function nil
   "Overrides the default `isearch-search-fun' behaviour.
-This variable should be a function, which will be called with no
-arguments, and should return a function that takes the same three
-arguments as `isearch-search-string' requires.")
+This variable's value should be a function, which will be called
+with no arguments, and should return a function that takes three
+arguments: STRING, BOUND, and NOERROR.
+
+This returned function will be used by `isearch-search-string' to
+search for the first occurrence of STRING or its translation.")
 
 (defun isearch-search-fun ()
   "Return the function to use for the search.